BPMN2CollaborationChecker.java

/*******************************************************************************
 * Signavio Core Components
 * Copyright (C) 2012  Signavio GmbH
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package de.hpi.bpmn2_0.validation;

import de.hpi.bpmn2_0.model.Collaboration;
import de.hpi.bpmn2_0.model.FlowElement;
import de.hpi.bpmn2_0.model.activity.Activity;
import de.hpi.bpmn2_0.model.connector.MessageFlow;
import de.hpi.bpmn2_0.model.conversation.ConversationLink;
import de.hpi.bpmn2_0.model.conversation.ConversationNode;
import de.hpi.bpmn2_0.model.event.CatchEvent;
import de.hpi.bpmn2_0.model.event.MessageEventDefinition;
import de.hpi.bpmn2_0.model.event.ThrowEvent;
import de.hpi.bpmn2_0.model.participant.Lane;
import de.hpi.bpmn2_0.model.participant.Participant;

public class BPMN2CollaborationChecker {

	// CONVERSATION
	protected static final String COMMUNICATION_AT_LEAST_TWO_PARTICIPANTS = "COMMUNICATION_AT_LEAST_TWO_PARTICIPANTS";
	protected static final String MESSAGEFLOW_SOURCE_MUST_BE_PARTICIPANT_MSGEVENT_ACTIVITY = "MESSAGEFLOW_START_MUST_BE_PARTICIPANT_MSGEVENT_ACTIVITY";
	protected static final String MESSAGEFLOW_TARGET_MUST_BE_PARTICIPANT_MSGEVENT_ACTIVITY = "MESSAGEFLOW_END_MUST_BE_PARTICIPANT_MSGEVENT_ACTIVITY";
	protected static final String CONV_LINK_CANNOT_CONNECT_CONV_NODES = "CONV_LINK_CANNOT_CONNECT_CONV_NODES";
	
	private BPMN2SyntaxChecker syntaxChecker;
	
	public BPMN2CollaborationChecker(BPMN2SyntaxChecker syntaxChecker) {
		this.syntaxChecker = syntaxChecker;
	}
	
	public void checkConversation(Collaboration conversation) {
		
		for(ConversationLink cLink : conversation.getConversationLink()) {
			checkConversationLink(cLink);
		}
		
		for(MessageFlow mFlow : conversation.getMessageFlow()) {
			checkMessageFlow(mFlow);
		}
		
		for(ConversationNode cNode : conversation.getConversationNode()) {
			checkConversationNode(cNode);
		}
		
		for(Participant participant : conversation.getParticipant()) {
			checkParticipant(participant);
		}
	}
	
	private void checkParticipant(Participant participant) {
		// TODO Auto-generated method stub
		
	}

	private void checkConversationNode(ConversationNode conversationNode) {
		if(conversationNode.getIncoming().size()+conversationNode.getOutgoing().size() < 2) {
			syntaxChecker.addError(conversationNode, COMMUNICATION_AT_LEAST_TWO_PARTICIPANTS);
		}
	}
	
	private void checkConversationLink(ConversationLink conversationLink) {
		if(conversationLink.getSourceRef() == null) {
			syntaxChecker.addError(conversationLink, BPMN2SyntaxChecker.NO_SOURCE);
		}
		
		if(conversationLink.getTargetRef() == null) {
			syntaxChecker.addError(conversationLink, BPMN2SyntaxChecker.NO_TARGET);
		}
		
		if(conversationLink.getSourceRef() != null && conversationLink.getTargetRef() != null && conversationLink.getSourceRef() instanceof ConversationNode && conversationLink.getTargetRef() instanceof ConversationNode) {
			syntaxChecker.addError(conversationLink, CONV_LINK_CANNOT_CONNECT_CONV_NODES);
		}
	}
	
	private void checkMessageFlow(MessageFlow messageFlow) {
		FlowElement source = messageFlow.getSourceRef();
		FlowElement target = messageFlow.getTargetRef();
		
		if(source == null) {
			syntaxChecker.addError(messageFlow, BPMN2SyntaxChecker.NO_SOURCE);
		}
		
		if(target == null) {
			syntaxChecker.addError(messageFlow, BPMN2SyntaxChecker.NO_TARGET);
		}
		
		if(source != null 
				&& !(source instanceof Participant 
						|| source instanceof Lane
						|| source instanceof Activity
						|| (source instanceof ThrowEvent 
								&& ((ThrowEvent) source).getEventDefinitionOfType(MessageEventDefinition.class) != null))) {
			syntaxChecker.addError(messageFlow, MESSAGEFLOW_SOURCE_MUST_BE_PARTICIPANT_MSGEVENT_ACTIVITY);
		}
		
		if(target != null 
				&& !(target instanceof Participant 
						|| target instanceof Lane
						|| target instanceof Activity
						|| (target instanceof CatchEvent 
								&& ((CatchEvent) target).getEventDefinitionOfType(MessageEventDefinition.class) != null))) {
			
			syntaxChecker.addError(messageFlow, MESSAGEFLOW_TARGET_MUST_BE_PARTICIPANT_MSGEVENT_ACTIVITY);
		}
	}
}